Crate gokz_rs

gokz.rs

A rust library for working with anything GOKZ!

This crate features basic types I didn’t want to write over and over again for every project, as well as some easy to use wrapper functions for calling popular APIs such as the GlobalAPI.

Features

By default, only some types are included. API wrappers and integrations with popular crates such as chrono and serde are hidden behind feature flags.

Re-exports

• pub use error::Error;
• pub use error::Result;
• pub use steam_id::SteamID;
• pub use mode::Mode;
• pub use rank::Rank;
• pub use runtype::Runtype;
• pub use tier::Tier;
• pub use map_identifier::MapIdentifier;
• pub use server_identifier::ServerIdentifier;
• pub use player_identifier::PlayerIdentifier;

Modules

• error
  The error type for this crate.
• map_identifier
  This module contains a utility type which is used a lot in the optional modules of this crate. It’s also really useful when working with serialized data.
• mode
  This module contains the 3 KZ modes.
• player_identifier
  Abstraction over a “player”. Many APIs accept either a player’s SteamID or name.
• prelude
  Most of what you probably need from this crate.
• rank
  This module holds an enum for player ranks. Based on points each player will have a rank assigned to them. The threshold for each of these ranks may also depend on the mode.
• runtype
  This module contains an enum for TP / PRO.
• server_identifier
  This module contains a utility type which is used a lot in the optional modules of this crate. It’s also really useful when working with serialized data.
• steam_id
  A unique identifier for steam accounts.
• tier
  This module contains an enum for the map tiers.
• util
  Module containing utility functions that I couldn’t find a better place for.

Macros

• yeet
  Early return with the given Error variant.